home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 April: Mac OS SDK / Dev.CD Apr 99 SDK1.toast / Development Kits / Interfaces&Libraries / Universal / Interfaces / AIncludes / InputSprocket.a < prev    next >
Encoding:
Text File  |  1998-08-17  |  29.2 KB  |  1,043 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        InputSprocket.a
  3. ;
  4. ;    Contains:    Games Sprockets: InputSprocket interfaaces
  5. ;
  6. ;    Version:    Technology:    Input Sprocket 1.3
  7. ;                Release:    Universal Interfaces 3.2
  8. ;
  9. ;    Copyright:    © 1996-1998 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        For bug reports, consult the following page on
  12. ;                the World Wide Web:
  13. ;
  14. ;                    http://developer.apple.com/bugreporter/
  15. ;
  16. ;
  17.     IF &TYPE('__INPUTSPROCKET__') = 'UNDEFINED' THEN
  18. __INPUTSPROCKET__ SET 1
  19.  
  20.     IF &TYPE('__MACTYPES__') = 'UNDEFINED' THEN
  21.     include 'MacTypes.a'
  22.     ENDIF
  23.     IF &TYPE('__EVENTS__') = 'UNDEFINED' THEN
  24.     include 'Events.a'
  25.     ENDIF
  26.  
  27.     IF &TYPE('USE_OLD_INPUT_SPROCKET_LABELS') = 'UNDEFINED' THEN
  28.     USE_OLD_INPUT_SPROCKET_LABELS: SET 0
  29.     ENDIF
  30.     IF &TYPE('USE_OLD_ISPNEED_STRUCT') = 'UNDEFINED' THEN
  31.     USE_OLD_ISPNEED_STRUCT: SET 0
  32.     ENDIF
  33. ;  ********************* data types ********************* 
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40. ;  ISpDeviceClass is a general classs of device, example: keyboard, mouse, joystick 
  41. ; typedef OSType                         ISpDeviceClass
  42.  
  43. ;  ISpDeviceIdentifier is a specific device,  example: standard 1-button mouse, 105key ext. kbd. 
  44. ; typedef OSType                         ISpDeviceIdentifier
  45.  
  46. ; typedef OSType                         ISpElementLabel
  47.  
  48. ; typedef OSType                         ISpElementKind
  49.  
  50.  
  51. ;  *************** errors -30420 to -30439***************** 
  52.  
  53. kISpInternalErr                    EQU        -30420
  54. kISpSystemListErr                EQU        -30421
  55. kISpBufferToSmallErr            EQU        -30422
  56. kISpElementInListErr            EQU        -30423
  57. kISpElementNotInListErr            EQU        -30424
  58. kISpSystemInactiveErr            EQU        -30425
  59. kISpDeviceInactiveErr            EQU        -30426
  60. kISpSystemActiveErr                EQU        -30427
  61. kISpDeviceActiveErr                EQU        -30428
  62. kISpListBusyErr                    EQU        -30429
  63. ;  *************** resources **************** 
  64.  
  65. kISpApplicationResourceType        EQU        'isap'
  66. kISpSetListResourceType            EQU        'setl'
  67. kISpSetDataResourceType            EQU        'setd'
  68. ISpApplicationResourceStruct RECORD 0
  69. flags                     ds.l    1                ; offset: $0 (0)
  70. reserved1                 ds.l    1                ; offset: $4 (4)
  71. reserved2                 ds.l    1                ; offset: $8 (8)
  72. reserved3                 ds.l    1                ; offset: $C (12)
  73. sizeof                     EQU *                    ; size:   $10 (16)
  74.                         ENDR
  75.  
  76. kISpAppResFlag_UsesInputSprocket EQU    $00000001            ; true if the application uses InputSprocket
  77. kISpAppResFlag_UsesISpInit        EQU        $00000002            ; true if the calls ISpInit (ie, uses the high level interface, calls ISpConfigure, has a needs list, etc...)
  78. ; 
  79. ; * ISpDeviceDefinition
  80. ; *
  81. ; * This structure provides all the available
  82. ; * information for an input device within the system
  83. ; *
  84. ; 
  85.  
  86. ISpDeviceDefinition        RECORD 0
  87. deviceName                 ds        Str63            ; offset: $0 (0)        ;  a human readable name of the device 
  88. theDeviceClass             ds.l    1                ; offset: $40 (64)        ;  general classs of device example : keyboard, mouse, joystick 
  89. theDeviceIdentifier         ds.l    1                ; offset: $44 (68)        ;  every distinguishable device should have an OSType 
  90. permanentID                 ds.l    1                ; offset: $48 (72)        ;  a cross reboot id unique within that deviceType, 0 if not possible 
  91. flags                     ds.l    1                ; offset: $4C (76)        ;  status flags 
  92. reserved1                 ds.l    1                ; offset: $50 (80)
  93. reserved2                 ds.l    1                ; offset: $54 (84)
  94. reserved3                 ds.l    1                ; offset: $58 (88)
  95. sizeof                     EQU *                    ; size:   $5C (92)
  96.                         ENDR
  97.  
  98. kISpDeviceFlag_HandleOwnEmulation EQU    1
  99. ; 
  100. ; * ISpElementEvent, ISpElementEventPtr
  101. ; *
  102. ; * This is the structure that event data is passed in.
  103. ; *
  104. ; 
  105.  
  106. ISpElementEvent            RECORD 0
  107. when                     ds        AbsoluteTime    ; offset: $0 (0)        ;  this is absolute time on PCI or later, otherwise it is 
  108. ;  0 for the hi 32 bits and TickCount for the low 32 bits 
  109. element                     ds.l    1                ; offset: $8 (8)        ;  a reference to the element that generated this event 
  110. refCon                     ds.l    1                ; offset: $C (12)        ;  for application usage, 0 on the global list 
  111. data                     ds.l    1                ; offset: $10 (16)        ;  the data for this event 
  112. sizeof                     EQU *                    ; size:   $14 (20)
  113.                         ENDR
  114. ; typedef struct ISpElementEvent *        ISpElementEventPtr
  115.  
  116. ; 
  117. ; * ISpElementInfo, ISpElementInfoPtr
  118. ; *
  119. ; * This is the generic definition of an element.
  120. ; * Every element must contain this information.
  121. ; *
  122. ; 
  123.  
  124. ISpElementInfo            RECORD 0
  125. theLabel                 ds.l    1                ; offset: $0 (0)
  126. theKind                     ds.l    1                ; offset: $4 (4)
  127. theString                 ds        Str63            ; offset: $8 (8)
  128. reserved1                 ds.l    1                ; offset: $48 (72)
  129. reserved2                 ds.l    1                ; offset: $4C (76)
  130. sizeof                     EQU *                    ; size:   $50 (80)
  131.                         ENDR
  132. ; typedef struct ISpElementInfo *        ISpElementInfoPtr
  133.  
  134. ; typedef UInt32                         ISpNeedFlagBits
  135.  
  136.     IF USE_OLD_ISPNEED_STRUCT THEN
  137. ISpNeed                    RECORD 0
  138. name                     ds        Str63            ; offset: $0 (0)
  139. iconSuiteResourceId         ds.w    1                ; offset: $40 (64)        ;  resource id of the icon suite 
  140. reserved                 ds.w    1                ; offset: $42 (66)
  141. theKind                     ds.l    1                ; offset: $44 (68)
  142. theLabel                 ds.l    1                ; offset: $48 (72)
  143. flags                     ds.l    1                ; offset: $4C (76)
  144. reserved1                 ds.l    1                ; offset: $50 (80)
  145. reserved2                 ds.l    1                ; offset: $54 (84)
  146. reserved3                 ds.l    1                ; offset: $58 (88)
  147. sizeof                     EQU *                    ; size:   $5C (92)
  148.                         ENDR
  149.     ELSE
  150. ISpNeed                    RECORD 0
  151. name                     ds        Str63            ; offset: $0 (0)        ;  human-readable string 
  152. iconSuiteResourceId         ds.w    1                ; offset: $40 (64)        ;  resource id of the icon suite 
  153. playerNum                 ds.b    1                ; offset: $42 (66)        ;  used for multi-player support 
  154. group                     ds.b    1                ; offset: $43 (67)        ;  used to group related needs (eg, look left and look right button needs) 
  155. theKind                     ds.l    1                ; offset: $44 (68)
  156. theLabel                 ds.l    1                ; offset: $48 (72)
  157. flags                     ds.l    1                ; offset: $4C (76)
  158. reserved1                 ds.l    1                ; offset: $50 (80)
  159. reserved2                 ds.l    1                ; offset: $54 (84)
  160. reserved3                 ds.l    1                ; offset: $58 (88)
  161. sizeof                     EQU *                    ; size:   $5C (92)
  162.                         ENDR
  163.     ENDIF    ; USE_OLD_ISPNEED_STRUCT
  164.  
  165. kISpNeedFlag_NoMultiConfig        EQU        $00000001            ; once this need is autoconfigured to one device dont autoconfigure to anything else
  166. kISpNeedFlag_Utility            EQU        $00000002            ; this need is a utility function (like show framerate) which would not typically be assigned to anything but the keyboard
  167. kISpNeedFlag_PolledOnly            EQU        $00000004
  168. kISpNeedFlag_EventsOnly            EQU        $00000008            ; *** kISpElementKind specific flags ***
  169.                                                             ; these are flags specific to kISpElementKind_Button
  170. kISpNeedFlag_Button_AlreadyAxis    EQU        $10000000            ; there is a axis version of this button need
  171. kISpNeedFlag_Button_ClickToggles EQU    $20000000
  172. kISpNeedFlag_Button_ActiveWhenDown EQU    $40000000
  173. kISpNeedFlag_Button_AlreadyDelta EQU    $80000000            ; there is a delta version of this button need
  174.                                                             ; these are flags specific to kISpElementKind_DPad
  175.                                                             ; these are flags specific to kISpElementKind_Axis
  176. kISpNeedFlag_Axis_AlreadyButton    EQU        $10000000            ; there is a button version of this axis need
  177. kISpNeedFlag_Axis_Asymetric        EQU        $20000000            ; this axis need is asymetric    
  178. kISpNeedFlag_Axis_AlreadyDelta    EQU        $40000000            ; there is a delta version of this axis need
  179.                                                             ; these are flags specific to kISpElementKind_Delta
  180. kISpNeedFlag_Delta_AlreadyAxis    EQU        $10000000            ; there is a axis version of this delta need
  181. kISpNeedFlag_Delta_AlreadyButton EQU    $20000000            ; there is a button version of this delta need
  182. ; 
  183. ; *
  184. ; * These are the current built values for ISpDeviceClass
  185. ; *
  186. ; 
  187.  
  188.  
  189. kISpDeviceClass_SpeechRecognition EQU    'talk'
  190. kISpDeviceClass_Mouse            EQU        'mous'
  191. kISpDeviceClass_Keyboard        EQU        'keyd'
  192. kISpDeviceClass_Joystick        EQU        'joys'
  193. kISpDeviceClass_Wheel            EQU        'whel'
  194. kISpDeviceClass_Pedals            EQU        'pedl'
  195. kISpDeviceClass_Levers            EQU        'levr'
  196. kISpDeviceClass_Tickle            EQU        'tckl'                ; a device of this class requires ISpTickle
  197. kISpDeviceClass_Unknown            EQU        '????'
  198. ; 
  199. ; * These are the current built in ISpElementKind's
  200. ; * 
  201. ; * These are all OSTypes.
  202. ; *
  203. ; 
  204.  
  205.  
  206. kISpElementKind_Button            EQU        'butn'
  207. kISpElementKind_DPad            EQU        'dpad'
  208. kISpElementKind_Axis            EQU        'axis'
  209. kISpElementKind_Delta            EQU        'dlta'
  210. kISpElementKind_Movement        EQU        'move'
  211. kISpElementKind_Virtual            EQU        'virt'
  212.  
  213. ; 
  214. ; *
  215. ; * These are the current built in ISpElementLabel's
  216. ; *
  217. ; * These are all OSTypes.
  218. ; *
  219. ; 
  220.  
  221.     IF USE_OLD_INPUT_SPROCKET_LABELS THEN
  222.  
  223.                                                             ; axis 
  224. kISpElementLabel_XAxis            EQU        'xaxi'
  225. kISpElementLabel_YAxis            EQU        'yaxi'
  226. kISpElementLabel_ZAxis            EQU        'zaxi'
  227. kISpElementLabel_Rx                EQU        'rxax'
  228. kISpElementLabel_Ry                EQU        'ryax'
  229. kISpElementLabel_Rz                EQU        'rzax'
  230. kISpElementLabel_Gas            EQU        'gasp'
  231. kISpElementLabel_Brake            EQU        'brak'
  232. kISpElementLabel_Clutch            EQU        'cltc'
  233. kISpElementLabel_Throttle        EQU        'thrt'
  234. kISpElementLabel_Trim            EQU        'trim'                ; direction pad 
  235. kISpElementLabel_POVHat            EQU        'povh'
  236. kISpElementLabel_PadMove        EQU        'move'                ; buttons 
  237. kISpElementLabel_Fire            EQU        'fire'
  238. kISpElementLabel_Start            EQU        'strt'
  239. kISpElementLabel_Select            EQU        'optn'
  240.     ENDIF    ; USE_OLD_INPUT_SPROCKET_LABELS
  241.  
  242.                                                             ; generic 
  243. kISpElementLabel_None            EQU        'none'                ; axis 
  244. kISpElementLabel_Axis_XAxis        EQU        'xaxi'
  245. kISpElementLabel_Axis_YAxis        EQU        'yaxi'
  246. kISpElementLabel_Axis_ZAxis        EQU        'zaxi'
  247. kISpElementLabel_Axis_Rx        EQU        'rxax'
  248. kISpElementLabel_Axis_Ry        EQU        'ryax'
  249. kISpElementLabel_Axis_Rz        EQU        'rzax'
  250. kISpElementLabel_Axis_Roll        EQU        'rzax'
  251. kISpElementLabel_Axis_Pitch        EQU        'rxax'
  252. kISpElementLabel_Axis_Yaw        EQU        'ryax'
  253. kISpElementLabel_Axis_RollTrim    EQU        'rxtm'
  254. kISpElementLabel_Axis_PitchTrim    EQU        'trim'
  255. kISpElementLabel_Axis_YawTrim    EQU        'rytm'
  256. kISpElementLabel_Axis_Gas        EQU        'gasp'
  257. kISpElementLabel_Axis_Brake        EQU        'brak'
  258. kISpElementLabel_Axis_Clutch    EQU        'cltc'
  259. kISpElementLabel_Axis_Throttle    EQU        'thrt'
  260. kISpElementLabel_Axis_Trim        EQU        'trim'
  261. kISpElementLabel_Axis_Rudder    EQU        'rudd'                ; delta 
  262. kISpElementLabel_Delta_X        EQU        'xdlt'
  263. kISpElementLabel_Delta_Y        EQU        'ydlt'
  264. kISpElementLabel_Delta_Z        EQU        'zdlt'
  265. kISpElementLabel_Delta_Rx        EQU        'rxdl'
  266. kISpElementLabel_Delta_Ry        EQU        'rydl'
  267. kISpElementLabel_Delta_Rz        EQU        'rzdl'
  268. kISpElementLabel_Delta_Roll        EQU        'rzdl'
  269. kISpElementLabel_Delta_Pitch    EQU        'rxdl'
  270. kISpElementLabel_Delta_Yaw        EQU        'rydl'                ; direction pad 
  271. kISpElementLabel_Pad_POV        EQU        'povh'                ; up/down/left/right
  272. kISpElementLabel_Pad_Move        EQU        'move'                ; up/down/left/right
  273. kISpElementLabel_Pad_POV_Horiz    EQU        'hpov'                ; forward/back/left/right
  274. kISpElementLabel_Pad_Move_Horiz    EQU        'hmov'                ; forward/back/left/right
  275.                                                             ; buttons 
  276. kISpElementLabel_Btn_Fire        EQU        'fire'
  277. kISpElementLabel_Btn_SecondaryFire EQU    'sfir'
  278. kISpElementLabel_Btn_Jump        EQU        'jump'
  279. kISpElementLabel_Btn_PauseResume EQU    'strt'                ; kISpElementLabel_Btn_PauseResume automatically binds to escape 
  280. kISpElementLabel_Btn_Select        EQU        'optn'
  281. kISpElementLabel_Btn_SlideLeft    EQU        'blft'
  282. kISpElementLabel_Btn_SlideRight    EQU        'brgt'
  283. kISpElementLabel_Btn_MoveForward EQU    'btmf'
  284. kISpElementLabel_Btn_MoveBackward EQU    'btmb'
  285. kISpElementLabel_Btn_TurnLeft    EQU        'bttl'
  286. kISpElementLabel_Btn_TurnRight    EQU        'bttr'
  287. kISpElementLabel_Btn_LookLeft    EQU        'btll'
  288. kISpElementLabel_Btn_LookRight    EQU        'btlr'
  289. kISpElementLabel_Btn_LookUp        EQU        'btlu'
  290. kISpElementLabel_Btn_LookDown    EQU        'btld'
  291. kISpElementLabel_Btn_Next        EQU        'btnx'
  292. kISpElementLabel_Btn_Previous    EQU        'btpv'
  293. kISpElementLabel_Btn_SideStep    EQU        'side'
  294. kISpElementLabel_Btn_Run        EQU        'quik'
  295. kISpElementLabel_Btn_Look        EQU        'blok'
  296. ; 
  297. ; *
  298. ; * direction pad data & configuration information
  299. ; *
  300. ; 
  301.  
  302. ; typedef UInt32                         ISpDPadData
  303.  
  304.  
  305. kISpPadIdle                        EQU        0
  306. kISpPadLeft                        EQU        1
  307. kISpPadUpLeft                    EQU        2
  308. kISpPadUp                        EQU        3
  309. kISpPadUpRight                    EQU        4
  310. kISpPadRight                    EQU        5
  311. kISpPadDownRight                EQU        6
  312. kISpPadDown                        EQU        7
  313. kISpPadDownLeft                    EQU        8
  314. ISpDPadConfigurationInfo RECORD 0
  315. id                         ds.l    1                ; offset: $0 (0)        ;  ordering 1..n, 0 = no relavent ordering of direction pads 
  316. fourWayPad                 ds.b    1                ; offset: $4 (4)        ;  true if this pad can only produce idle + four directions 
  317.                          ORG 6
  318. sizeof                     EQU *                    ; size:   $6 (6)
  319.                         ENDR
  320. ; 
  321. ; *
  322. ; * button data & configuration information
  323. ; *
  324. ; 
  325.  
  326. ; typedef UInt32                         ISpButtonData
  327.  
  328.  
  329. kISpButtonUp                    EQU        0
  330. kISpButtonDown                    EQU        1
  331. ISpButtonConfigurationInfo RECORD 0
  332. id                         ds.l    1                ; offset: $0 (0)        ;  ordering 1..n, 0 = no relavent ordering of buttons 
  333. sizeof                     EQU *                    ; size:   $4 (4)
  334.                         ENDR
  335. ; 
  336. ; *
  337. ; * axis data & configuration information 
  338. ; *
  339. ; 
  340.  
  341. ; typedef UInt32                         ISpAxisData
  342.  
  343. ISpAxisConfigurationInfo RECORD 0
  344. symetricAxis             ds.b    1                ; offset: $0 (0)        ;  axis is symetric, i.e. a joystick is symetric and a gas pedal is not 
  345.                          ORG 2
  346. sizeof                     EQU *                    ; size:   $2 (2)
  347.                         ENDR
  348. ; typedef Fixed                         ISpDeltaData
  349.  
  350. ISpDeltaConfigurationInfo RECORD 0
  351. reserved1                 ds.l    1                ; offset: $0 (0)
  352. reserved2                 ds.l    1                ; offset: $4 (4)
  353. sizeof                     EQU *                    ; size:   $8 (8)
  354.                         ENDR
  355. ISpMovementData            RECORD 0
  356. xAxis                     ds.l    1                ; offset: $0 (0)
  357. yAxis                     ds.l    1                ; offset: $4 (4)
  358. direction                 ds.l    1                ; offset: $8 (8)        ;  ISpDPadData version of the movement 
  359. sizeof                     EQU *                    ; size:   $C (12)
  360.                         ENDR
  361. ISpMovementConfigurationInfo RECORD 0
  362. reserved1                 ds.l    1                ; offset: $0 (0)
  363. reserved2                 ds.l    1                ; offset: $4 (4)
  364. sizeof                     EQU *                    ; size:   $8 (8)
  365.                         ENDR
  366.  
  367. kISpVirtualElementFlag_UseTempMem EQU    1
  368.  
  369. kISpElementListFlag_UseTempMem    EQU        1
  370.  
  371. kISpFirstIconSuite                EQU        30000
  372. kISpLastIconSuite                EQU        30100
  373. kISpNoneIconSuite                EQU        30000
  374.  
  375.     IF TARGET_RT_MAC_CFM THEN
  376. ;  ********************* user level functions ********************* 
  377. ; 
  378. ; *
  379. ; * startup / shutdown
  380. ; *
  381. ; 
  382.  
  383. ;
  384. ; extern OSStatus ISpStartup(void )
  385. ;
  386.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  387.         IMPORT_CFM_FUNCTION ISpStartup
  388.     ENDIF
  389.  
  390. ;  1.1 or later
  391. ;
  392. ; extern OSStatus ISpShutdown(void )
  393. ;
  394.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  395.         IMPORT_CFM_FUNCTION ISpShutdown
  396.     ENDIF
  397.  
  398. ;  1.1 or later
  399. ; 
  400. ; *
  401. ; * polling
  402. ; *
  403. ; 
  404.  
  405. ;
  406. ; extern OSStatus ISpTickle(void )
  407. ;
  408.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  409.         IMPORT_CFM_FUNCTION ISpTickle
  410.     ENDIF
  411.  
  412. ;  1.1 or later
  413. ; ********** user interface functions *********
  414.  
  415. ;
  416. ; extern NumVersion ISpGetVersion(void )
  417. ;
  418.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  419.         IMPORT_CFM_FUNCTION ISpGetVersion
  420.     ENDIF
  421.  
  422. ; 
  423. ; *
  424. ; * ISpElement_NewVirtual(ISpElementReference *outElement);
  425. ; *
  426. ; 
  427.  
  428. ;
  429. ; extern OSStatus ISpElement_NewVirtual(UInt32 dataSize, ISpElementReference *outElement, UInt32 flags)
  430. ;
  431.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  432.         IMPORT_CFM_FUNCTION ISpElement_NewVirtual
  433.     ENDIF
  434.  
  435. ; 
  436. ; *
  437. ; * ISpElement_NewVirtualFromNeeds(UInt32 count, ISpNeeds *needs, ISpElementReference *outElements);
  438. ; *
  439. ; 
  440.  
  441. ;
  442. ; extern OSStatus ISpElement_NewVirtualFromNeeds(UInt32 count, ISpNeed *needs, ISpElementReference *outElements, UInt32 flags)
  443. ;
  444.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  445.         IMPORT_CFM_FUNCTION ISpElement_NewVirtualFromNeeds
  446.     ENDIF
  447.  
  448. ; 
  449. ; *
  450. ; * ISpElement_DisposeVirtual(inElement);
  451. ; *
  452. ; 
  453.  
  454. ;
  455. ; extern OSStatus ISpElement_DisposeVirtual(UInt32 count, ISpElementReference *inElements)
  456. ;
  457.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  458.         IMPORT_CFM_FUNCTION ISpElement_DisposeVirtual
  459.     ENDIF
  460.  
  461. ; 
  462. ; * ISpInit
  463. ; *
  464. ; 
  465.  
  466. ;
  467. ; extern OSStatus ISpInit(UInt32 count, ISpNeed *needs, ISpElementReference *inReferences, OSType appCreatorCode, OSType subCreatorCode, UInt32 flags, short setListResourceId, UInt32 reserved)
  468. ;
  469.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  470.         IMPORT_CFM_FUNCTION ISpInit
  471.     ENDIF
  472.  
  473.  
  474. ; 
  475. ; * ISpConfigure
  476. ; *
  477. ; 
  478.  
  479. ;
  480. ; extern OSStatus ISpConfigure(ISpEventProcPtr inEventProcPtr)
  481. ;
  482.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  483.         IMPORT_CFM_FUNCTION ISpConfigure
  484.     ENDIF
  485.  
  486. ; 
  487. ; *
  488. ; * ISpStop
  489. ; *
  490. ; 
  491.  
  492. ;
  493. ; extern OSStatus ISpStop(void )
  494. ;
  495.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  496.         IMPORT_CFM_FUNCTION ISpStop
  497.     ENDIF
  498.  
  499. ; 
  500. ; *
  501. ; * ISpSuspend, ISpResume
  502. ; *
  503. ; * ISpSuspend turns all devices off and allocates memory so that the state may be later resumed.
  504. ; * ISpResume resumes to the previous state of the system after a suspend call.
  505. ; * 
  506. ; * Return Codes
  507. ; * memFullErr
  508. ; *
  509. ; 
  510.  
  511. ;
  512. ; extern OSStatus ISpSuspend(void )
  513. ;
  514.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  515.         IMPORT_CFM_FUNCTION ISpSuspend
  516.     ENDIF
  517.  
  518. ;
  519. ; extern OSStatus ISpResume(void )
  520. ;
  521.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  522.         IMPORT_CFM_FUNCTION ISpResume
  523.     ENDIF
  524.  
  525. ; 
  526. ; * ISpDevices_Extract, ISpDevices_ExtractByClass, ISpDevices_ExtractByIdentifier
  527. ; *
  528. ; * These will extract as many device references from the system wide list as will fit in your buffer.  
  529. ; *
  530. ; * inBufferCount - the size of your buffer (in units of sizeof(ISpDeviceReference)) this may be zero
  531. ; * buffer - a pointer to your buffer
  532. ; * outCount - contains the number of devices in the system
  533. ; *
  534. ; * ISpDevices_ExtractByClass extracts and counts devices of the specified ISpDeviceClass
  535. ; * ISpDevices_ExtractByIdentifier extracts and counts devices of the specified ISpDeviceIdentifier
  536. ; *
  537. ; * Return Codes
  538. ; * paramErr
  539. ; *
  540. ; 
  541.  
  542. ;
  543. ; extern OSStatus ISpDevices_Extract(UInt32 inBufferCount, UInt32 *outCount, ISpDeviceReference *buffer)
  544. ;
  545.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  546.         IMPORT_CFM_FUNCTION ISpDevices_Extract
  547.     ENDIF
  548.  
  549. ;
  550. ; extern OSStatus ISpDevices_ExtractByClass(ISpDeviceClass inClass, UInt32 inBufferCount, UInt32 *outCount, ISpDeviceReference *buffer)
  551. ;
  552.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  553.         IMPORT_CFM_FUNCTION ISpDevices_ExtractByClass
  554.     ENDIF
  555.  
  556. ;
  557. ; extern OSStatus ISpDevices_ExtractByIdentifier(ISpDeviceIdentifier inIdentifier, UInt32 inBufferCount, UInt32 *outCount, ISpDeviceReference *buffer)
  558. ;
  559.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  560.         IMPORT_CFM_FUNCTION ISpDevices_ExtractByIdentifier
  561.     ENDIF
  562.  
  563.  
  564. ; 
  565. ; * ISpDevices_ActivateClass, ISpDevices_DeactivateClass, ISpDevices_Activate, ISpDevices_Deactivate, ISpDevice_IsActive
  566. ; *
  567. ; * ISpDevices_Activate, ISpDevices_Deactivate
  568. ; *
  569. ; * This will activate/deactivate a block of devices.
  570. ; * inDeviceCount - the number of devices to activate / deactivate
  571. ; * inDevicesToActivate/inDevicesToDeactivate - a pointer to a block of memory contains the devices references
  572. ; *
  573. ; * ISpDevices_ActivateClass, ISpDevices_DeactivateClass
  574. ; * inClass - the class of devices to activate or deactivate
  575. ; *
  576. ; * ISpDevice_IsActive
  577. ; * inDevice - the device reference that you wish to 
  578. ; * outIsActive - a boolean value that is true when the device is active
  579. ; *
  580. ; * Return Codes
  581. ; * paramErr
  582. ; *
  583. ; 
  584.  
  585. ;
  586. ; extern OSStatus ISpDevices_ActivateClass(ISpDeviceClass inClass)
  587. ;
  588.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  589.         IMPORT_CFM_FUNCTION ISpDevices_ActivateClass
  590.     ENDIF
  591.  
  592. ;  1.1 or later
  593. ;
  594. ; extern OSStatus ISpDevices_DeactivateClass(ISpDeviceClass inClass)
  595. ;
  596.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  597.         IMPORT_CFM_FUNCTION ISpDevices_DeactivateClass
  598.     ENDIF
  599.  
  600. ;  1.1 or later
  601. ;
  602. ; extern OSStatus ISpDevices_Activate(UInt32 inDeviceCount, ISpDeviceReference *inDevicesToActivate)
  603. ;
  604.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  605.         IMPORT_CFM_FUNCTION ISpDevices_Activate
  606.     ENDIF
  607.  
  608. ;
  609. ; extern OSStatus ISpDevices_Deactivate(UInt32 inDeviceCount, ISpDeviceReference *inDevicesToDeactivate)
  610. ;
  611.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  612.         IMPORT_CFM_FUNCTION ISpDevices_Deactivate
  613.     ENDIF
  614.  
  615. ;
  616. ; extern OSStatus ISpDevice_IsActive(ISpDeviceReference inDevice, Boolean *outIsActive)
  617. ;
  618.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  619.         IMPORT_CFM_FUNCTION ISpDevice_IsActive
  620.     ENDIF
  621.  
  622. ; 
  623. ; * ISpDevice_GetDefinition
  624. ; *
  625. ; *
  626. ; * inDevice - the device you want to get the definition for
  627. ; * inBuflen - the size of the structure (sizeof(ISpDeviceDefinition))
  628. ; * outStruct - a pointer to where you want the structure copied
  629. ; *
  630. ; * Return Codes
  631. ; * paramErr
  632. ; *
  633. ; 
  634.  
  635. ;
  636. ; extern OSStatus ISpDevice_GetDefinition(ISpDeviceReference inDevice, UInt32 inBuflen, ISpDeviceDefinition *outStruct)
  637. ;
  638.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  639.         IMPORT_CFM_FUNCTION ISpDevice_GetDefinition
  640.     ENDIF
  641.  
  642.  
  643. ; 
  644. ; *
  645. ; * ISpDevice_GetElementList
  646. ; *
  647. ; * inDevice - the device whose element list you wish to get
  648. ; * outElementList - a pointer to where you want a reference to that list stored
  649. ; *
  650. ; * Return Codes
  651. ; * paramErr
  652. ; *
  653. ; 
  654.  
  655. ;
  656. ; extern OSStatus ISpDevice_GetElementList(ISpDeviceReference inDevice, ISpElementListReference *outElementList)
  657. ;
  658.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  659.         IMPORT_CFM_FUNCTION ISpDevice_GetElementList
  660.     ENDIF
  661.  
  662. ; 
  663. ; *
  664. ; * takes an ISpElementReference and returns the group that it is in or 0 if there is
  665. ; * no group
  666. ; *
  667. ; * Return Codes
  668. ; * paramErr
  669. ; *
  670. ; 
  671.  
  672. ;
  673. ; extern OSStatus ISpElement_GetGroup(ISpElementReference inElement, UInt32 *outGroup)
  674. ;
  675.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  676.         IMPORT_CFM_FUNCTION ISpElement_GetGroup
  677.     ENDIF
  678.  
  679. ; 
  680. ; *
  681. ; * takes an ISpElementReference and returns the device that the element belongs 
  682. ; * to.
  683. ; *
  684. ; * Return Codes
  685. ; * paramErr if inElement is 0 or outDevice is nil
  686. ; *
  687. ; 
  688.  
  689. ;
  690. ; extern OSStatus ISpElement_GetDevice(ISpElementReference inElement, ISpDeviceReference *outDevice)
  691. ;
  692.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  693.         IMPORT_CFM_FUNCTION ISpElement_GetDevice
  694.     ENDIF
  695.  
  696. ; 
  697. ; *
  698. ; * takes an ISpElementReference and gives the ISpElementInfo for that Element.  This is the
  699. ; * the set of standard information.  You get ISpElementKind specific information
  700. ; * through ISpElement_GetConfigurationInfo.
  701. ; *
  702. ; * Return Codes
  703. ; * paramErr if inElement is 0 or outInfo is nil
  704. ; *
  705. ; 
  706.  
  707. ;
  708. ; extern OSStatus ISpElement_GetInfo(ISpElementReference inElement, ISpElementInfoPtr outInfo)
  709. ;
  710.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  711.         IMPORT_CFM_FUNCTION ISpElement_GetInfo
  712.     ENDIF
  713.  
  714. ; 
  715. ; *
  716. ; *         
  717. ; *
  718. ; * takes an ISpElementReference and gives the ISpElementKind specific configuration information
  719. ; * 
  720. ; * if buflen is not long enough to hold the information ISpElement_GetConfigurationInfo will
  721. ; * copy buflen bytes of the data into the block of memory pointed to by configInfo and
  722. ; * will return something error.
  723. ; *
  724. ; * Return Codes
  725. ; * paramErr if inElement or configInfo is nil
  726. ; *
  727. ; 
  728.  
  729. ;
  730. ; extern OSStatus ISpElement_GetConfigurationInfo(ISpElementReference inElement, UInt32 buflen, void *configInfo)
  731. ;
  732.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  733.         IMPORT_CFM_FUNCTION ISpElement_GetConfigurationInfo
  734.     ENDIF
  735.  
  736. ; 
  737. ; *
  738. ; * ISpElement_GetSimpleState
  739. ; *
  740. ; * Takes an ISpElementReference and returns the current state of that element.  This is a 
  741. ; * specialized version of ISpElement_GetComplexState that is only appropriate for elements
  742. ; * whose data fits in a signed 32 bit integer.
  743. ; *
  744. ; *
  745. ; *
  746. ; * Return Codes
  747. ; * paramErr if inElement is 0 or state is nil
  748. ; *
  749. ; 
  750.  
  751. ;
  752. ; extern OSStatus ISpElement_GetSimpleState(ISpElementReference inElement, UInt32 *state)
  753. ;
  754.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  755.         IMPORT_CFM_FUNCTION ISpElement_GetSimpleState
  756.     ENDIF
  757.  
  758. ; 
  759. ; *
  760. ; * ISpElement_GetComplexState
  761. ; *
  762. ; * Takes an ISpElementReference and returns the current state of that element.  
  763. ; * Will copy up to buflen bytes of the current state of the device into
  764. ; * state.
  765. ; *
  766. ; *
  767. ; * Return Codes
  768. ; * paramErr if inElement is 0 or state is nil
  769. ; *
  770. ; 
  771.  
  772. ;
  773. ; extern OSStatus ISpElement_GetComplexState(ISpElementReference inElement, UInt32 buflen, void *state)
  774. ;
  775.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  776.         IMPORT_CFM_FUNCTION ISpElement_GetComplexState
  777.     ENDIF
  778.  
  779.  
  780. ; 
  781. ; * ISpElement_GetNextEvent
  782. ; *
  783. ; * It takes in an element  reference and the buffer size of the ISpElementEventPtr
  784. ; * it will set wasEvent to true if there was an event and false otherwise.  If there
  785. ; * was not enough space to fill in the whole event structure that event will be
  786. ; * dequed, as much of the event as will fit in the buffer will by copied and
  787. ; * ISpElement_GetNextEvent will return an error.
  788. ; *
  789. ; * Return Codes
  790. ; * paramErr
  791. ; *
  792. ; 
  793.  
  794. ;
  795. ; extern OSStatus ISpElement_GetNextEvent(ISpElementReference inElement, UInt32 bufSize, ISpElementEventPtr event, Boolean *wasEvent)
  796. ;
  797.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  798.         IMPORT_CFM_FUNCTION ISpElement_GetNextEvent
  799.     ENDIF
  800.  
  801. ; 
  802. ; *
  803. ; * ISpElement_Flush
  804. ; *
  805. ; * It takes an ISpElementReference and flushes all the events on that element.  All it guaruntees is
  806. ; * that any events that made it to this layer before the time of the flush call will be flushed and
  807. ; * it will not flush any events that make it to this layer after the time when the call has returned.
  808. ; * What happens to events that occur during the flush is undefined.
  809. ; *
  810. ; *
  811. ; * Return Codes
  812. ; * paramErr
  813. ; *
  814. ; 
  815.  
  816. ;
  817. ; extern OSStatus ISpElement_Flush(ISpElementReference inElement)
  818. ;
  819.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  820.         IMPORT_CFM_FUNCTION ISpElement_Flush
  821.     ENDIF
  822.  
  823.  
  824.  
  825. ; 
  826. ; * ISpElementList_New
  827. ; *
  828. ; * Creates a new element list and returns it in outElementList.  In count specifies 
  829. ; * the number of element references in the list pointed to by inElements.  If inCount
  830. ; * is non zero the list is created with inCount elements in at as specified by the 
  831. ; * inElements parameter.  Otherwise the list is created empty.
  832. ; *
  833. ; *
  834. ; * Return Codes
  835. ; * out of memory - If it failed to allocate the list because it was out of memory
  836. ;                   it will also set outElementList to 0
  837. ; * paramErr if outElementList was nil
  838. ; *
  839. ; *
  840. ; * Special Concerns
  841. ; *
  842. ; * interrupt unsafe
  843. ; *
  844. ; 
  845.  
  846. ;
  847. ; extern OSStatus ISpElementList_New(UInt32 inCount, ISpElementReference *inElements, ISpElementListReference *outElementList, UInt32 flags)
  848. ;
  849.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  850.         IMPORT_CFM_FUNCTION ISpElementList_New
  851.     ENDIF
  852.  
  853. ; 
  854. ; * ISpElementList_Dispose
  855. ; *
  856. ; * Deletes an already existing memory list.  
  857. ; *
  858. ; *
  859. ; * Return Codes
  860. ; * paramErr if inElementList was 0
  861. ; *
  862. ; *
  863. ; * Special Concerns
  864. ; *
  865. ; * interrupt unsafe
  866. ; *
  867. ; 
  868.  
  869. ;
  870. ; extern OSStatus ISpElementList_Dispose(ISpElementListReference inElementList)
  871. ;
  872.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  873.         IMPORT_CFM_FUNCTION ISpElementList_Dispose
  874.     ENDIF
  875.  
  876. ; 
  877. ; * ISpGetGlobalElementList
  878. ; *
  879. ; * returns the global element list
  880. ; *
  881. ; * Return Codes
  882. ; * paramErr if outElementList is nil
  883. ; *
  884. ; 
  885.  
  886. ;
  887. ; extern OSStatus ISpGetGlobalElementList(ISpElementListReference *outElementList)
  888. ;
  889.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  890.         IMPORT_CFM_FUNCTION ISpGetGlobalElementList
  891.     ENDIF
  892.  
  893. ; 
  894. ; * ISpElementList_AddElement
  895. ; *
  896. ; * adds an element to the element list
  897. ; *
  898. ; * Return Codes
  899. ; * paramErr if inElementList is 0 or newElement is 0
  900. ; * memory error if the system is unable to allocate enough memory
  901. ; *
  902. ; * Special Concerns
  903. ; * interrupt Unsafe
  904. ; * 
  905. ; 
  906.  
  907. ;
  908. ; extern OSStatus ISpElementList_AddElements(ISpElementListReference inElementList, UInt32 refCon, UInt32 count, ISpElementReference *newElements)
  909. ;
  910.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  911.         IMPORT_CFM_FUNCTION ISpElementList_AddElements
  912.     ENDIF
  913.  
  914. ; 
  915. ; * ISpElementList_RemoveElement
  916. ; *
  917. ; * removes the specified element from the element list
  918. ; *
  919. ; * Return Codes
  920. ; * paramErr if inElementList is 0 or oldElement is 0
  921. ; * memory error if the system is unable to allocate enough memory
  922. ; *
  923. ; * Special Concerns
  924. ; * interrupt Unsafe
  925. ; * 
  926. ; 
  927.  
  928. ;
  929. ; extern OSStatus ISpElementList_RemoveElements(ISpElementListReference inElementList, UInt32 count, ISpElementReference *oldElement)
  930. ;
  931.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  932.         IMPORT_CFM_FUNCTION ISpElementList_RemoveElements
  933.     ENDIF
  934.  
  935. ; 
  936. ; * ISpElementList_Extract
  937. ; *
  938. ; * ISpElementList_Extract will extract as many of the elements from an element list as possible.  You pass
  939. ; * in an element list, a pointer to an array of element references and the number of elements in that array.
  940. ; * It will return how many items are in the element list in the outCount parameter and copy the minimum of 
  941. ; * that number and the size of the array into the buffer.
  942. ; *
  943. ; * ByKind and ByLabel are the same except that they will only count and copy element references to elements
  944. ; * that have the specified kind and label.
  945. ; *
  946. ; * Return Codes
  947. ; * paramErr
  948. ; *
  949. ; 
  950.  
  951. ;
  952. ; extern OSStatus ISpElementList_Extract(ISpElementListReference inElementList, UInt32 inBufferCount, UInt32 *outCount, ISpElementReference *buffer)
  953. ;
  954.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  955.         IMPORT_CFM_FUNCTION ISpElementList_Extract
  956.     ENDIF
  957.  
  958. ;
  959. ; extern OSStatus ISpElementList_ExtractByKind(ISpElementListReference inElementList, ISpElementKind inKind, UInt32 inBufferCount, UInt32 *outCount, ISpElementReference *buffer)
  960. ;
  961.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  962.         IMPORT_CFM_FUNCTION ISpElementList_ExtractByKind
  963.     ENDIF
  964.  
  965. ;
  966. ; extern OSStatus ISpElementList_ExtractByLabel(ISpElementListReference inElementList, ISpElementLabel inLabel, UInt32 inBufferCount, UInt32 *outCount, ISpElementReference *buffer)
  967. ;
  968.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  969.         IMPORT_CFM_FUNCTION ISpElementList_ExtractByLabel
  970.     ENDIF
  971.  
  972. ; 
  973. ; * ISpElementList_GetNextEvent
  974. ; *
  975. ; * It takes in an element list reference and the buffer size of the ISpElementEventPtr
  976. ; * it will set wasEvent to true if there was an event and false otherwise.  If there
  977. ; * was not enough space to fill in the whole event structure that event will be
  978. ; * dequed, as much of the event as will fit in the buffer will by copied and
  979. ; * ISpElementList_GetNextEvent will return an error.
  980. ; *
  981. ; * Return Codes
  982. ; * paramErr
  983. ; *
  984. ; 
  985.  
  986. ;
  987. ; extern OSStatus ISpElementList_GetNextEvent(ISpElementListReference inElementList, UInt32 bufSize, ISpElementEventPtr event, Boolean *wasEvent)
  988. ;
  989.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  990.         IMPORT_CFM_FUNCTION ISpElementList_GetNextEvent
  991.     ENDIF
  992.  
  993. ; 
  994. ; *
  995. ; * ISpElementList_Flush
  996. ; *
  997. ; * It takes an ISpElementListReference and flushes all the events on that list.  All it guaruntees is
  998. ; * that any events that made it to this layer before the time of the flush call will be flushed and
  999. ; * it will not flush any events that make it to this layer after the time when the call has returned.
  1000. ; * What happens to events that occur during the flush is undefined.
  1001. ; *
  1002. ; *
  1003. ; * Return Codes
  1004. ; * paramErr
  1005. ; *
  1006. ; 
  1007.  
  1008. ;
  1009. ; extern OSStatus ISpElementList_Flush(ISpElementListReference inElementList)
  1010. ;
  1011.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1012.         IMPORT_CFM_FUNCTION ISpElementList_Flush
  1013.     ENDIF
  1014.  
  1015. ; 
  1016. ; *
  1017. ; * ISpTimeToMicroseconds
  1018. ; *
  1019. ; *
  1020. ; * This function takes time from an input sprocket event and converts it
  1021. ; * into microseconds. (Version 1.2 or later of InputSprocket.)
  1022. ; *
  1023. ; *
  1024. ; * Return Codes
  1025. ; * paramErr
  1026. ; *
  1027. ; 
  1028.  
  1029. ;
  1030. ; extern OSStatus ISpTimeToMicroseconds(const AbsoluteTime *inTime, UnsignedWide *outMicroseconds)
  1031. ;
  1032.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1033.         IMPORT_CFM_FUNCTION ISpTimeToMicroseconds
  1034.     ENDIF
  1035.  
  1036.     ENDIF    ; TARGET_RT_MAC_CFM
  1037.  
  1038.  
  1039.  
  1040.  
  1041.     ENDIF ; __INPUTSPROCKET__ 
  1042.  
  1043.